OPC Studio User's Guide and Reference
FindFile(IEasyUAFileTransfer,UAEndpointDescriptor,UANodeDescriptor,IReadOnlyList<String>,String) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.FileTransfer Namespace > IEasyUAFileTransferExtension Class > FindFile Method : FindFile(IEasyUAFileTransfer,UAEndpointDescriptor,UANodeDescriptor,IReadOnlyList<String>,String) Method
The OPC UA file transfer object that will perform the operation.
Endpoint descriptor. Identifies the OPC-UA server.
Node descriptor of the OPC UA directory.
A path consisting of names of subdirectories starting from directoryNodeDescriptor forwards.
The name of the file to find.
Finds a file object under the specified parent directory.
Syntax

Parameters

fileTransfer
The OPC UA file transfer object that will perform the operation.
endpointDescriptor
Endpoint descriptor. Identifies the OPC-UA server.
directoryNodeDescriptor
Node descriptor of the OPC UA directory.
directoryPathElements
A path consisting of names of subdirectories starting from directoryNodeDescriptor forwards.
fileName
The name of the file to find.

Return Value

Returns a tuple consisting of a node descriptor of the parent directory, and a node descriptor of the file object. The node descriptor of the file object is non-null, if the file was found; it is null otherwise.
Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also